Repository navigation
packaging: rocksdb by default for full nodes; docs and set-up texts aligned - #173
Merged
Merged
Conversation
…ligned - Docker entrypoint and guided set-up (setup.sh, setup.ps1): a new full node defaults to rocksdb, which starts from a snapshot; pruned stays on lmdb. Existing installs keep their backend: a database already in db/, or the db_backend of config.ini (a full [storage] without one keeps berkeleydb, the node's own default). The entrypoint also detects the backend of a database whose config.ini was removed. - Full node disk: about 250 to 300 GB with rocksdb (entrypoint log, .env, set-up questions 1 and 3b); backfill: about 2 to 3 days (more on a slow disk or few cores). - docker-compose.yml: cpus and mem_limit from CREDITS_CPUS (1.5) and CREDITS_MEMORY (4g) in .env; a full node sets 4 and 8g. - README: linux-x64 needs glibc 2.38, linux-x64-glibc2.31 covers older systems. CHANGES intro: ghcr.io/creditscommunity/credits-node. - make-package.sh: the config.pruned.ini comment describes the snapshot start ([snapshot] fetch=auto, the default) instead of a sync from block 0. - quick-start, storage.md, Docker README updated. - ci: setup-test checks the rocksdb default and that a full berkeleydb configuration or database is kept; the Docker entrypoint test checks the rocksdb default and an existing berkeleydb install. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
EnzinoBB
added a commit
that referenced
this pull request
Nov 7, 2026
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
A full node now defaults to rocksdb, in Docker (
CREDITS_STORAGE=full) and in the guided set-up (setup.sh,setup.ps1). The previous default, berkeleydb, cannot start from a snapshot and syncs from block 0. Pruned keeps lmdb. The node's ownconfig.inidefault (no[storage]: berkeleydb) does not change.Existing installs do not change:
db/keeps its backend (as before); a fullconfig.inithat names a backend keeps it (now includingberkeleydb/berkeley/rocks); a full[storage]withoutdb_backend(prune_keep_blocks=0) keeps berkeleydb, which is what the node runs with it;config.iniis written on the first start only and always namesdb_backend, so existing containers keep theirs; a config withoutdb_backendstill reads as berkeleydb. New: whenconfig.iniis missing butdb/holds a database andCREDITS_DB_BACKENDis unset, the entrypoint writesconfig.inifor the backend already there (.storage, then the db fingerprints) instead of the new default.Texts aligned (found while writing docs/quick-start.md, #172):
.env.example, set-up question 1 "tens of GB" and question 3b "130 GB", both scripts)..env.example, the entrypoint log and the Docker README.linux-x64needs glibc 2.38;linux-x64-glibc2.31runs on glibc 2.31.docker-compose.yml:cpus: ${CREDITS_CPUS:-1.5},mem_limit: ${CREDITS_MEMORY:-4g}. I chose.envvariables over a comment only: the defaults (pruned-friendly) are unchanged, and a full-node operator sets two lines in.env, the file they already edit, instead of editingdocker-compose.yml, which a later download would overwrite. Checked withdocker compose config(1.5/4g by default, 4/8g when set). Documented in.env.example, the Docker README and the quick-start.docs/CHANGES.mdintro:ghcr.io/creditscommunity/credits-node(historical rows unchanged).make-package.sh: theconfig.pruned.inicomment now says the node starts from a snapshot (--download-snapshot, or the neighbours with[snapshot] fetch=auto, the default, sinceconfig.pruned.inihas no[snapshot]section) and syncs from block 0 only when none comes withinfetch_wait.docs/quick-start.md: rocksdb is the full default (Docker section and set-up table; the variable stays in the example), Docker limits viaCREDITS_CPUS=4/CREDITS_MEMORY=8g. Alsodocs/storage.md(Docker table) and the Docker README.The set-up's database question now lists
rocksdb/lmdb/berkeleydband says which ones start from a snapshot.Tests
packaging/docker/test/test-entrypoint.sh(run locally, PASS): full default is rocksdb and downloads the snapshot; berkeleydb on request does not fetch; new case 6h: an existing full berkeleydb install (config withoutdb_backend, then config removed with a berkeleydbdb/) keeps berkeleydb.setup-test.yml: the full berkeleydb step now answersberkeleydband checks the[rocksdb]default; new step "A full berkeleydb configuration is kept on Enter" (config naming berkeleydb, and a berkeleydb database with the package's config); the full rocksdb step starts from the package's config and takes the default with Enter.setup.shon the real community.17linux-x64package with piped answers: fresh full → rocksdb, backfill on, fetch=auto; berkeleydb config kept on Enter; berkeleydb database kept; full[storage]without db_backend kept on berkeleydb; pruned → lmdb.🤖 Generated with Claude Code